/**
 * Copyright (C) 2002-2015   The FreeCol Team
 * <p>
 * This file is part of FreeCol.
 * <p>
 * FreeCol is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 2 of the License, or
 * (at your option) any later version.
 * <p>
 * FreeCol is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 * <p>
 * You should have received a copy of the GNU General Public License
 * along with FreeCol.  If not, see <http://www.gnu.org/licenses/>.
 */

package net.sf.freecol.common.io;

import java.io.File;
import java.io.FileFilter;
import java.io.IOException;

import net.sf.freecol.common.resources.ResourceMapping;


/**
 * A Total Conversion (TC).  Rules are TCs.
 */
public class FreeColTcFile extends FreeColModFile
{

    /** A file filter to select TCs. */
    private static final FileFilter fileFilter
            = makeFileFilter( MOD_DESCRIPTOR_FILE, "ftc", ZIP_FILE_EXTENSION );


    /**
     * Opens the given file for reading.
     *
     * @param file The file to load.
     * @throws IOException if thrown while opening the file.
     */
    public FreeColTcFile( final File file ) throws IOException
    {
        super( file );
    }

    /**
     * Opens the file with the given name for reading.
     *
     * @param id The identifier of the TC to load.
     * @throws IOException if thrown while opening the file.
     */
    public FreeColTcFile( final String id ) throws IOException
    {
        super( new File( FreeColDirectories.getRulesDirectory( ), id ) );
    }


    /**
     * {@inheritDoc}
     */
    @Override
    public ResourceMapping getResourceMapping( )
    {
        ResourceMapping result = new ResourceMapping( );
        try
        {
            if ( getParent( ) != null )
            {
                final FreeColTcFile parentTcData = new FreeColTcFile( getParent( ) );
                result.addAll( parentTcData.getResourceMapping( ) );
            }
            // Add the local data *after* the parent data so that the local
            // values can override (eventual call is Map.putAll).
            // Note that FreeColDataFile.getResourceMapping logs the load,
            // and thus the log messages will appear to be in the reverse
            // order, which mislead me until looking at the code.
            result.addAll( super.getResourceMapping( ) );
        }
        catch ( IOException e )
        {
            throw new RuntimeException( e );
        }
        return result;
    }

    /**
     * Get the file filter to select TC files.
     *
     * @return The TC file filter.
     */
    public static FileFilter getFileFilter( )
    {
        return fileFilter;
    }
}
